Improve wording and add usage example on the DropboxFileUrlAgent description.

Guilherme J. Tramontina 10 年之前
父节点
当前提交
5f9d45b68a
共有 1 个文件被更改,包括 3 次插入1 次删除
  1. 3 1
      app/models/agents/dropbox_file_url_agent.rb

+ 3 - 1
app/models/agents/dropbox_file_url_agent.rb

@@ -6,7 +6,7 @@ module Agents
6 6
 
7 7
     description <<-MD
8 8
       #{'## Include the `dropbox-api` and `omniauth-dropbox` gems in your `Gemfile` and set `DROPBOX_OAUTH_KEY` and `DROPBOX_OAUTH_SECRET` in your environment to use Dropbox Agents.' if dependencies_missing?}
9
-      The _DropboxFileUrlAgent_ takes a file path (or multiple files paths) and emits
9
+      The _DropboxFileUrlAgent_ is used to work with Dropbox. It takes a file path (or multiple files paths) and emits
10 10
       events with [temporary links](https://www.dropbox.com/developers/core/docs#media).
11 11
 
12 12
       The incoming event payload needs to have a `paths` key, with a comma-separated list of files you want the URL for. For example:
@@ -25,6 +25,8 @@ module Agents
25 25
             "mode": "clean"
26 26
           }
27 27
 
28
+      An example of usage would be to watch a specific Dropbox directory (with the _DropboxWatchAgent_) and get the URLs for the added or updated files. You could then, for example, send emails with those links.
29
+
28 30
     MD
29 31
 
30 32
     event_description <<-MD